Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-02

oracle.AWXML
Class AllocationArgument

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.AllocationArgument

public class AllocationArgument
extends BaseObject

An object that contains one or more parameters that affect an allocation operation. Each parameter is represented by a Parameter object. A Parameter for an allocation operation has a keyword and most of them also have a value.

An AllocationArgument is owned by an Allocation. The Allocation also owns an AllocationOperator, which specifies the type of allocation operation, such as an even or a proportional allocation.

See Also:
Allocation, Parameter

Fields inherited from class oracle.AWXML.BaseObject
DATABASENULL

 

Constructor Summary
AllocationArgument(BaseObject input)
          Creates an AllocationArgument for the specified Allocation.

 

Method Summary
 void addParameter(Parameter input)
          Adds the specified Parameter to the AllocationArgument.
 Parameter createParameter()
          Creates a new Parameter and adds it to the list of Parameter objects owned by the AllocationArgument.
 java.lang.String getArgumentText()
          Gets the keywords and values of the Parameter objects that are owned by the AllocationArgument.
 java.util.Vector getParameters()
          Gets the list of Parameter objects that are owned by the AllocationArgument.
 void removeParameter(Parameter input)
          Removes the specified Parameter from the AllocationArgument.
 java.lang.String WriteToXML()
          Gets an XML representation of the AllocationArgument.

 

Methods inherited from class oracle.AWXML.BaseObject
Alter, Create, CreateAfter, CreateBefore, CreateFirst, DataRead, Delete, getColumnName, getId, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

AllocationArgument

public AllocationArgument(BaseObject input)
Creates an AllocationArgument for the specified Allocation. An application should create an AllocationArgument by using the createAllocationArgument method of the Allocation.
Parameters:
input - The Allocation to own the AllocationArgument.

Method Detail

WriteToXML

public java.lang.String WriteToXML()
Gets an XML representation of the AllocationArgument.
Overrides:
WriteToXML in class BaseObject
Returns:
An XML String that represents the AllocationArgument.

addParameter

public void addParameter(Parameter input)
Adds the specified Parameter to the AllocationArgument.
Parameters:
input - The Parameter to add.

removeParameter

public void removeParameter(Parameter input)
Removes the specified Parameter from the AllocationArgument.
Parameters:
input - The Parameter to remove.

getParameters

public java.util.Vector getParameters()
Gets the list of Parameter objects that are owned by the AllocationArgument.
Returns:
A Vector of Parameter objects.

createParameter

public Parameter createParameter()
Creates a new Parameter and adds it to the list of Parameter objects owned by the AllocationArgument.
Returns:
The new Parameter.

getArgumentText

public java.lang.String getArgumentText()
Gets the keywords and values of the Parameter objects that are owned by the AllocationArgument.
Returns:
A String that contains the keywords and values of the Parameter objects of the AllocationArgument.

Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)

B14351-02

Copyright © 2003, 2005 Oracle. All rights reserved.